/**
 * 
 */
package model;

import controller.Controller;

/**
 * This class represents the state which shows the user how to play and provides the "back story" for the game
 *
 */
public class HowToPlayState extends State {

	/**
	 * Returns the state name
	 */
	@Override
	public String getStateName() {
		return "HOW_TO_PLAY_STATE";
	}

	/**
	 * This has no effect in this state
	 */
	@Override
	void pauseButtonPressed(GameDriver d) {
	}

	/**
	 * Brings the player to the setup state, and starts the game
	 */
	@Override
	void advanceState(GameDriver d) {
		d.setCurrentState(GameDriver.setupStageState);
		String waveMessage = d.getMap().getCurrentWave().getWaveDescription();
		int waveMessageDuration = d.getMap().getCurrentWave().getWaveDescriptionDuration();
		Controller.displayHighPriorityMessage(waveMessage, waveMessageDuration);
	}

	/**
	 * This has no effect in this state
	 */
	@Override
	void returnToMainMenu(GameDriver d) {
		
	}

}
